<html>
<head><meta charset="utf-8"><title>documenting rustdoc in the reference · t-lang/doc · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/index.html">t-lang/doc</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html">documenting rustdoc in the reference</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="226066503"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226066503" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226066503">(Feb 11 2021 at 22:18)</a>:</h4>
<p>It came up in <a href="https://github.com/rust-lang/rust/pull/80874">https://github.com/rust-lang/rust/pull/80874</a> that the rustdoc book is not a great place for all the details of how rustdoc behaves, because it's meant to be a guide more than a reference. Is there anything about rustdoc in the reference? If not, would you be interested in me adding some info?</p>



<a name="226072581"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226072581" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Lokathor <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226072581">(Feb 11 2021 at 23:17)</a>:</h4>
<p>do you mean things like the doc attribute being in the reference? yeah that should be</p>



<a name="226072700"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226072700" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226072700">(Feb 11 2021 at 23:18)</a>:</h4>
<p>that, and also how rustdoc behaves really strangely sometimes: <a href="https://github.com/rust-lang/rust/pull/80874#issuecomment-777696740">https://github.com/rust-lang/rust/pull/80874#issuecomment-777696740</a></p>



<a name="226072752"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226072752" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226072752">(Feb 11 2021 at 23:18)</a>:</h4>
<p>like I don't think the word "inlining" is mentioned in any documentation at <em>all</em> currently</p>



<a name="226086869"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226086869" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Eric Huss <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226086869">(Feb 12 2021 at 02:35)</a>:</h4>
<p>I would prefer to keep the reference to be about the language, and less about the tools. I think it would be reasonable just to add chapters to the rustdoc book. As an example, the Cargo Book includes a separate Guide and Reference section.</p>



<a name="226086929"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226086929" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226086929">(Feb 12 2021 at 02:36)</a>:</h4>
<p>hmm, ok, that's reasonable</p>



<a name="226157924"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226157924" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Lokathor <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226157924">(Feb 12 2021 at 16:14)</a>:</h4>
<p>oh yeah, precisely how rustdoc renders is well outside the reference's scope</p>



<a name="226157972"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/237824-t-lang/doc/topic/documenting%20rustdoc%20in%20the%20reference/near/226157972" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Lokathor <a href="https://rust-lang.github.io/zulip_archive/stream/237824-t-lang/doc/topic/documenting.20rustdoc.20in.20the.20reference.html#226157972">(Feb 12 2021 at 16:15)</a>:</h4>
<p>It is enough to say "there are these attributes here, they work like this, and you can read more here (link)"</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>